home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 081 / opus100c.arc / OREF_LOG.ARC / OREF_LOG.DOC
Encoding:
Text File  |  1987-01-16  |  5.7 KB  |  136 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.           ###########   ############  ####        #### ############
  7.          #############  #############  ##          ##  ############
  8.          ###       ###  ##        ###  ##          ##  ##         #
  9.          ##         ##  ##         ##  ##          ##  ##
  10.          ##         ##  ##        ###  ##          ##  ###
  11.          ##         ##  #############  ##          ##   ########## 
  12.          ##         ##  ############   ##          ##   ###########
  13.          ##         ##  ##             ##          ##           ###
  14.          ##         ##  ##             ##          ##            ##
  15.          ##         ##  ##             ##          ##            ##
  16.          ###       ###  ##             ###        ###  #         ##
  17.          #############  ##             ##############  ############
  18.           ###########  ####             ############   ########### 
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.                               Log File Standards
  27.                               ------------------
  28.  
  29.  
  30.                  The POLE's OPUS Computer Conversation System
  31.             (c)Copyright, 1986; Wynn Wagner III; All Rights Reserved
  32.  
  33.                              9 Septrmber 1986
  34.  
  35.  
  36.  
  37. ------------------------------------------------------------------------------
  38. LOG STRUCTURE
  39.  
  40. Because there is no standardized log structure among bulletin boards,
  41. we've decided to make one.  OPUS will respect this format.  If anybody 
  42. wants to join us, feel free.
  43.  
  44.   * Programs are not required to share a log with any other process that
  45.     may be running.  That means from the time a program begins until the
  46.     time it exits (or forks or execs to another program), it is the sole
  47.     owner of its log file.
  48.  
  49.          NOTE: If you are running two copies of Opus with something like
  50.                DoubleDos, it is very important that you use two separate
  51.                log files.
  52.  
  53.   * Programs should flush and close the log file before exiting or forking
  54.     to another program or before bringing up a copy of Command.Com.  In
  55.     other words, it *IS* legal for a child process to use the same log.
  56.  
  57.          NOTE: Some programs (eg. SeaDog) apparently don't flush or close
  58.                its log before bringing up a second or third copy of
  59.                Command.Com.  It is unwise to have Opus share the same
  60.                log with SeaDog.
  61.  
  62.   * Each line consists of these parts:
  63.  
  64.          SYMBOL........... !  - an important entry, usually an error
  65.                            +  - a regular entry
  66.                            :  - a non-important message
  67.                            #  - tracer statements
  68.                            *  - network
  69.                            _  - <space> video message only, not logged
  70.          DAY.............. one or two digits
  71.          MONTH............ three-character month name
  72.          TIME............. 24-hr clock in the form hh:mm:ss
  73.          PROGRAM.......... as many as 8 characters/digits, no spaces
  74.          MESSAGE.......... as many as 80 characters/digits/etc
  75.          END-OF-LINE...... A cr/lf for MsDOS
  76.  
  77.     That comes to about 107 characters as the maximum line length.  Each
  78.     item is be separated by a space (not a TAB).  Until you get to MESSAGE,
  79.     none of the items can contain a space ... that's the delimeter.
  80.  
  81.     The tracer type statement is a "debug" sort of thing right now, but
  82.     its real intent is to allow you to get extremely detailed information
  83.     on a particular user (eg. "Trace Bri..."). That's in the future, though.
  84.  
  85.   * Three line items are standard:
  86.  
  87.          EMPTY LINE....... A program first sends an END-OF-LINE to the
  88.                            log file to insure a fresh start for its entries.
  89.  
  90.          BEGIN TIME....... The second line marks the startup time.  It has
  91.                            a `+' symbol.  The message itself is not defined,
  92.                            but the item following PROGRAM must be the word
  93.                            "begin" (case is irrelevant).
  94.  
  95.                            + 20 Sep 12:30:05 OPUS begin, v1.0
  96.  
  97.          END TIME......... The last item is an off-line message.  It's just
  98.                            like the BEGIN TIME, but represents the time
  99.                            when the program stopped execution.  After PROGRAM
  100.                            you will find the word "end".
  101.  
  102.   * For Opus, the BEGIN line will include the version number and the
  103.     current task number for multi-tasking environments.
  104.  
  105.   * For Opus, the PROGRAM name will always be "OPUS".
  106.  
  107.   * In Opus, there are several levels of logging: Trace, Verbose,
  108.     Regular, and Terse.  The level is set by each individual sysop
  109.     using a statement in the control file.  Here is a chart of the 
  110.     kinds of messages that appear in the various flavors of logs:
  111.  
  112.  
  113.                  |   !   |   +   |   :   |   #   |   *   |   <sp>    |
  114.          --------+-------+-------+-------+-------+-------+-----------|
  115.          TRACE   |   X   |   X   |   X   |   X   |   X   |           |
  116.          --------+-------+-------+-------+-------+-------+-----------|
  117.          VERBOSE |   X   |   X   |   X   |       |   X   |           |
  118.          --------+-------+-------+-------+-------+-------+-----------|
  119.          REGULAR |   X   |   X   |       |       |   X   |           |
  120.          --------+-------+-------+-------+-------+-------+-----------|
  121.          TERSE   |   X   |       |       |       |   X   |           |
  122.          --------+-------+-------+-------+-------+-------+-----------|
  123.          VIDEO   |   X   |   s   |   s   |   s   |   s   |     s     |
  124.          --------+-------+-------+-------+-------+-------+-----------|
  125.  
  126.                            X = used
  127.  
  128.                            s = used only if SNOOP MODE is turned OFF
  129.  
  130.  
  131.  
  132.  
  133.                                      ###
  134.  
  135.  
  136.